Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

End-To-End Dokumentation and cleanup #645

Merged
merged 5 commits into from
Sep 15, 2022
Merged

End-To-End Dokumentation and cleanup #645

merged 5 commits into from
Sep 15, 2022

Conversation

SuyDesignz
Copy link
Contributor

@jplag/maintainer @jplag/studdev
Changes made to README.md documentation. Hereby spelling mistakes, as well as structures, were revised which should provide better comprehensibility and readability. Adapt and normalize expressions to uniformity in the terms. Also change of options for the test runs, because the old options do not provide enough coverage for default settings from (1, 15) to (9, 3).

@SuyDesignz SuyDesignz changed the title end-to-end Dokumentation and cleanup End-To-End Dokumentation and cleanup Sep 7, 2022
@JanWittler JanWittler requested a review from a team September 7, 2022 11:08
@tsaglam tsaglam added enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change labels Sep 7, 2022
@tsaglam tsaglam added this to the v4.0.0 milestone Sep 7, 2022
@tsaglam
Copy link
Member

tsaglam commented Sep 9, 2022

@SuyDesignz this is currently still a draft PR. Is that correct?

@SuyDesignz SuyDesignz marked this pull request as ready for review September 11, 2022 12:12
@dfuchss
Copy link
Member

dfuchss commented Sep 12, 2022

@SuyDesignz please resolve merge conflicts. You may have to regenerate the results.

tsaglam
tsaglam requested changes Sep 12, 2022
View reviewed changes
Copy link
Member

@tsaglam tsaglam left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is a bit confusing. @SuyDesignz can you elaborate on why you changed the min token matches?

@JanWittler
Copy link
Contributor

This PR is a bit confusing. @SuyDesignz can you elaborate on why you changed the min token matches?

Probably due to my comments in #632:

Also, you motivate things using a minimum token match of 1. This value makes no sense at all for code, as this will trigger a match whenever two times the same token is extracted and does not require any structural similarity. Also, why 15? The default match of Java is 9 and thus this should be the first reference to use. As a comparison, you could e.g. take 3,4,5 or similar. They should still show the point that a lower MTM increases the similarity.

@SuyDesignz
Merge remote-tracking branch 'origin/master' into feature/endToEndDok…
0b0747c 
…umentation

# Conflicts:
#	jplag.endtoend-testing/src/test/resources/results/java/sortAlgo.json
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@tsaglam tsaglam merged commit eaecc8a into jplag:master Sep 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JanWittler JanWittler JanWittler left review comments

@tsaglam tsaglam tsaglam approved these changes

@dfuchss dfuchss dfuchss approved these changes

Assignees
No one assigned
Labels
enhancement Issue/PR that involves features, improvements and other changes minor Minor issue/feature/contribution/change
Projects
No open projects
v4.0.0 Release
Status: Done
Milestone
v4.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@SuyDesignz @tsaglam @dfuchss @JanWittler